PlotIconMethod

PlotIconMethod
Header:	Icons.h		Carbon status:	Supported

Draws an icon obtained with the aid of your icon getter callback function.

OSErr PlotIconMethod (
    const Rect *theRect, 
    IconAlignmentType align, 
    IconTransformType transform, 
    IconGetterUPP theMethod, 
    void *yourDataPtr
);

theRect

A pointer to the rectangle in which to draw the icon, specified in local coordinates of the current graphics port.

align

Specifies how to align the icon within the specified rectangle. See “Alignment Type Values” for a description of the values you can use here.

transform

Specifies how the function should modify the appearance of the icon. See “Transform Type Values” for a description of the values you can use here.

theMethod

A universal procedure pointer to your icon getter callback function. PlotIconMethod uses your icon getter function to obtain the icon to draw.

PlotIconMethod passes to your icon getter function the type of the icon to draw and the value specified in the yourDataPtr parameter. The PlotIconMethod function examines the current bit depth of the display devices and calls your icon getter function once for each display device that intersects the rectangle specified in the parameter theRect. Your icon getter function should return a handle to the requested icon’s data. Your icon getter function can get the icon data using whatever method is appropriate to your application. For example, your application might maintain its own cache of icons or use its icon getter function to get an icon from the desktop database.

For more information see the IconGetterProcPtr callback.

yourDataPtr

A pointer to data that is passed to your icon getter callback function.

function result: A result code.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.